Namespace: compute

compute alpha

Compute Engine API

Creates and runs virtual machines on Google Cloud Platform.

Version:
  • alpha

Example

var google = require('googleapis');
var compute = google.compute('alpha');

Methods

staticcompute(alpha).compute.addresses.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 61

Retrieves an aggregated list of addresses.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.addresses.delete(params, callback){object}

apis/compute/alpha.js, line 91

Deletes the specified address resource.

Name Type Description
params object

Parameters for request

Name Type Description
address string

Name of the address resource to delete.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.addresses.get(params, callback){object}

apis/compute/alpha.js, line 121

Returns the specified address resource.

Name Type Description
params object

Parameters for request

Name Type Description
address string

Name of the address resource to return.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.addresses.insert(params, callback){object}

apis/compute/alpha.js, line 151

Creates an address resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).Address

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.addresses.list(params, callback){object}

apis/compute/alpha.js, line 184

Retrieves a list of addresses contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.addresses.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 215

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 251

Retrieves an aggregated list of autoscalers.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.delete(params, callback){object}

apis/compute/alpha.js, line 281

Deletes the specified autoscaler.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to delete.

project string

Project ID for this request.

zone string

Name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.get(params, callback){object}

apis/compute/alpha.js, line 311

Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to return.

project string

Project ID for this request.

zone string

Name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.insert(params, callback){object}

apis/compute/alpha.js, line 341

Creates an autoscaler in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.list(params, callback){object}

apis/compute/alpha.js, line 374

Retrieves a list of autoscalers contained within the specified zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

Name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.patch(params, callback){object}

apis/compute/alpha.js, line 405

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to update.

project string

Project ID for this request.

zone string

Name of the zone for this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 436

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.autoscalers.update(params, callback){object}

apis/compute/alpha.js, line 467

Updates an autoscaler in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string optional

Name of the autoscaler to update.

project string

Project ID for this request.

zone string

Name of the zone for this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.delete(params, callback){object}

apis/compute/alpha.js, line 500

Deletes the specified BackendBucket resource.

Name Type Description
params object

Parameters for request

Name Type Description
backendBucket string

Name of the BackendBucket resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.get(params, callback){object}

apis/compute/alpha.js, line 529

Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
backendBucket string

Name of the BackendBucket resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 558

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.insert(params, callback){object}

apis/compute/alpha.js, line 587

Creates a BackendBucket resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).BackendBucket

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.list(params, callback){object}

apis/compute/alpha.js, line 619

Retrieves the list of BackendBucket resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.patch(params, callback){object}

apis/compute/alpha.js, line 649

Update the entire content of the BackendBucket resource. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
backendBucket string

Name of the BackendBucket resource to update.

project string

Project ID for this request.

resource compute(alpha).BackendBucket

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 679

Sets the access control policy on the specified resource. Replaces any existing policy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).Policy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 709

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendBuckets.update(params, callback){object}

apis/compute/alpha.js, line 739

Update the entire content of the BackendBucket resource.

Name Type Description
params object

Parameters for request

Name Type Description
backendBucket string

Name of the BackendBucket resource to update.

project string

Project ID for this request.

resource compute(alpha).BackendBucket

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.delete(params, callback){object}

apis/compute/alpha.js, line 772

Deletes the specified BackendService resource.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.get(params, callback){object}

apis/compute/alpha.js, line 801

Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.getHealth(params, callback){object}

apis/compute/alpha.js, line 831

Gets the most recent health check results for this BackendService.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to which the queried instance belongs.

project string
resource compute(alpha).ResourceGroupReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.insert(params, callback){object}

apis/compute/alpha.js, line 860

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.list(params, callback){object}

apis/compute/alpha.js, line 892

Retrieves the list of BackendService resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.patch(params, callback){object}

apis/compute/alpha.js, line 922

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to update.

project string

Project ID for this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 952

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.backendServices.update(params, callback){object}

apis/compute/alpha.js, line 982

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to update.

project string

Project ID for this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.clientSslPolicies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1016

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1151

Retrieves an aggregated list of persistent disks.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.createSnapshot(params, callback){object}

apis/compute/alpha.js, line 1183

Creates a snapshot of a specified persistent disk.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the persistent disk to snapshot.

guestFlush boolean optional
project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Snapshot

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.delete(params, callback){object}

apis/compute/alpha.js, line 1213

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the persistent disk to delete.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.get(params, callback){object}

apis/compute/alpha.js, line 1243

Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the persistent disk to return.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.insert(params, callback){object}

apis/compute/alpha.js, line 1274

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

sourceImage string optional

Optional. Source image to restore onto a disk.

zone string

The name of the zone for this request.

resource compute(alpha).Disk

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.list(params, callback){object}

apis/compute/alpha.js, line 1307

Retrieves a list of persistent disks contained within the specified zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.resize(params, callback){object}

apis/compute/alpha.js, line 1338

Resizes the specified persistent disk.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

The name of the persistent disk.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).DisksResizeRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.setLabels(params, callback){object}

apis/compute/alpha.js, line 1369

Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).ZoneSetLabelsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.disks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1400

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.diskTypes.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1052

Retrieves an aggregated list of disk types.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.diskTypes.get(params, callback){object}

apis/compute/alpha.js, line 1082

Returns the specified disk type. Get a list of available disk types by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
diskType string

Name of the disk type to return.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.diskTypes.list(params, callback){object}

apis/compute/alpha.js, line 1115

Retrieves a list of disk types available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.delete(params, callback){object}

apis/compute/alpha.js, line 1433

Deletes the specified firewall.

Name Type Description
params object

Parameters for request

Name Type Description
firewall string

Name of the firewall rule to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.get(params, callback){object}

apis/compute/alpha.js, line 1462

Returns the specified firewall.

Name Type Description
params object

Parameters for request

Name Type Description
firewall string

Name of the firewall rule to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.insert(params, callback){object}

apis/compute/alpha.js, line 1491

Creates a firewall rule in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Firewall

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.list(params, callback){object}

apis/compute/alpha.js, line 1523

Retrieves the list of firewall rules available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.patch(params, callback){object}

apis/compute/alpha.js, line 1553

Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
firewall string

Name of the firewall rule to update.

project string

Project ID for this request.

resource compute(alpha).Firewall

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1583

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.firewalls.update(params, callback){object}

apis/compute/alpha.js, line 1613

Updates the specified firewall rule with the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
firewall string

Name of the firewall rule to update.

project string

Project ID for this request.

resource compute(alpha).Firewall

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1649

Retrieves an aggregated list of forwarding rules.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.delete(params, callback){object}

apis/compute/alpha.js, line 1679

Deletes the specified ForwardingRule resource.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource to delete.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.get(params, callback){object}

apis/compute/alpha.js, line 1709

Returns the specified ForwardingRule resource.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource to return.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.insert(params, callback){object}

apis/compute/alpha.js, line 1739

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).ForwardingRule

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.list(params, callback){object}

apis/compute/alpha.js, line 1772

Retrieves a list of ForwardingRule resources available to the specified project and region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.setTarget(params, callback){object}

apis/compute/alpha.js, line 1803

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource in which target is to be set.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).TargetReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.forwardingRules.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1834

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalAddresses.delete(params, callback){object}

apis/compute/alpha.js, line 1867

Deletes the specified address resource.

Name Type Description
params object

Parameters for request

Name Type Description
address string

Name of the address resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalAddresses.get(params, callback){object}

apis/compute/alpha.js, line 1896

Returns the specified address resource. Get a list of available addresses by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
address string

Name of the address resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalAddresses.insert(params, callback){object}

apis/compute/alpha.js, line 1925

Creates an address resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Address

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalAddresses.list(params, callback){object}

apis/compute/alpha.js, line 1957

Retrieves a list of global addresses.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalAddresses.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1987

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.delete(params, callback){object}

apis/compute/alpha.js, line 2020

Deletes the specified ForwardingRule resource.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.get(params, callback){object}

apis/compute/alpha.js, line 2049

Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.insert(params, callback){object}

apis/compute/alpha.js, line 2078

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).ForwardingRule

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.list(params, callback){object}

apis/compute/alpha.js, line 2110

Retrieves a list of ForwardingRule resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.setTarget(params, callback){object}

apis/compute/alpha.js, line 2140

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Name Type Description
params object

Parameters for request

Name Type Description
forwardingRule string

Name of the ForwardingRule resource in which target is to be set.

project string

Project ID for this request.

resource compute(alpha).TargetReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalForwardingRules.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2170

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalOperations.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 2206

Retrieves an aggregated list of all operations.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalOperations.delete(params, callback){object}

apis/compute/alpha.js, line 2235

Deletes the specified Operations resource.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalOperations.get(params, callback){object}

apis/compute/alpha.js, line 2264

Retrieves the specified Operations resource. Get a list of operations by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.globalOperations.list(params, callback){object}

apis/compute/alpha.js, line 2296

Retrieves a list of Operation resources contained within the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2329

Deletes the specified HealthCheck resource.

Name Type Description
params object

Parameters for request

Name Type Description
healthCheck string

Name of the HealthCheck resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2358

Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
healthCheck string

Name of the HealthCheck resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2387

Creates a HealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).HealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2419

Retrieves the list of HealthCheck resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2449

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
healthCheck string

Name of the HealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2479

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.healthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2509

Updates a HealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
healthCheck string

Name of the HealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2542

Deletes the specified HttpHealthCheck resource.

Name Type Description
params object

Parameters for request

Name Type Description
httpHealthCheck string

Name of the HttpHealthCheck resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2571

Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
httpHealthCheck string

Name of the HttpHealthCheck resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2600

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).HttpHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2632

Retrieves the list of HttpHealthCheck resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2662

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
httpHealthCheck string

Name of the HttpHealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HttpHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2692

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpHealthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2722

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
httpHealthCheck string

Name of the HttpHealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HttpHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2755

Deletes the specified HttpsHealthCheck resource.

Name Type Description
params object

Parameters for request

Name Type Description
httpsHealthCheck string

Name of the HttpsHealthCheck resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2784

Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
httpsHealthCheck string

Name of the HttpsHealthCheck resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2813

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).HttpsHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2845

Retrieves the list of HttpsHealthCheck resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2875

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
httpsHealthCheck string

Name of the HttpsHealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HttpsHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2905

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.httpsHealthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2935

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
httpsHealthCheck string

Name of the HttpsHealthCheck resource to update.

project string

Project ID for this request.

resource compute(alpha).HttpsHealthCheck

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.delete(params, callback){object}

apis/compute/alpha.js, line 2968

Deletes the specified image.

Name Type Description
params object

Parameters for request

Name Type Description
image string

Name of the image resource to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.deprecate(params, callback){object}

apis/compute/alpha.js, line 2998

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Name Type Description
params object

Parameters for request

Name Type Description
image string

Image name.

project string

Project ID for this request.

resource compute(alpha).DeprecationStatus

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.get(params, callback){object}

apis/compute/alpha.js, line 3027

Returns the specified image. Get a list of available images by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
image string

Name of the image resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.getFromFamily(params, callback){object}

apis/compute/alpha.js, line 3056

Returns the latest image that is part of an image family and is not deprecated.

Name Type Description
params object

Parameters for request

Name Type Description
family string

Name of the image family to search for.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.insert(params, callback){object}

apis/compute/alpha.js, line 3085

Creates an image in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Image

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.list(params, callback){object}

apis/compute/alpha.js, line 3117

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.setLabels(params, callback){object}

apis/compute/alpha.js, line 3147

Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).GlobalSetLabelsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.images.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 3177

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.abandonInstances(params, callback){object}

apis/compute/alpha.js, line 3212

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersAbandonInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 3244

Retrieves the list of managed instance groups and groups them by zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.delete(params, callback){object}

apis/compute/alpha.js, line 3274

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group to delete.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.deleteInstances(params, callback){object}

apis/compute/alpha.js, line 3305

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersDeleteInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.get(params, callback){object}

apis/compute/alpha.js, line 3335

Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.insert(params, callback){object}

apis/compute/alpha.js, line 3365

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

The name of the zone where you want to create the managed instance group.

resource compute(alpha).InstanceGroupManager

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.list(params, callback){object}

apis/compute/alpha.js, line 3398

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.listManagedInstances(params, callback){object}

apis/compute/alpha.js, line 3428

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.patch(params, callback){object}

apis/compute/alpha.js, line 3459

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the instance group manager.

project string

Project ID for this request.

zone string

The name of the zone where you want to create the managed instance group.

resource compute(alpha).InstanceGroupManager

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.recreateInstances(params, callback){object}

apis/compute/alpha.js, line 3490

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersRecreateInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.resize(params, callback){object}

apis/compute/alpha.js, line 3521

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

size integer

The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

zone string

The name of the zone where the managed instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.resizeAdvanced(params, callback){object}

apis/compute/alpha.js, line 3552

Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersResizeAdvancedRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.setAutoHealingPolicies(params, callback){object}

apis/compute/alpha.js, line 3583

Modifies the autohealing policies.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the instance group manager.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersSetAutoHealingRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.setInstanceTemplate(params, callback){object}

apis/compute/alpha.js, line 3614

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersSetInstanceTemplateRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.setTargetPools(params, callback){object}

apis/compute/alpha.js, line 3645

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

resource compute(alpha).InstanceGroupManagersSetTargetPoolsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 3676

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroupManagers.update(params, callback){object}

apis/compute/alpha.js, line 3707

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the instance group manager.

project string

Project ID for this request.

zone string

The name of the zone where you want to create the managed instance group.

resource compute(alpha).InstanceGroupManager

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.addInstances(params, callback){object}

apis/compute/alpha.js, line 3742

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the instance group where you are adding instances.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

resource compute(alpha).InstanceGroupsAddInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 3774

Retrieves the list of instance groups and sorts them by zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.delete(params, callback){object}

apis/compute/alpha.js, line 3804

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the instance group to delete.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.get(params, callback){object}

apis/compute/alpha.js, line 3834

Returns the specified instance group. Get a list of available instance groups by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the instance group.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.insert(params, callback){object}

apis/compute/alpha.js, line 3864

Creates an instance group in the specified project using the parameters that are included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

The name of the zone where you want to create the instance group.

resource compute(alpha).InstanceGroup

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.list(params, callback){object}

apis/compute/alpha.js, line 3897

Retrieves the list of instance groups that are located in the specified project and zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.listInstances(params, callback){object}

apis/compute/alpha.js, line 3932

Lists the instances in the specified instance group.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

instanceGroup string

The name of the instance group from which you want to generate a list of included instances.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

resource compute(alpha).InstanceGroupsListInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.removeInstances(params, callback){object}

apis/compute/alpha.js, line 3963

Removes one or more instances from the specified instance group, but does not delete those instances.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the instance group where the specified instances will be removed.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

resource compute(alpha).InstanceGroupsRemoveInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.setNamedPorts(params, callback){object}

apis/compute/alpha.js, line 3994

Sets the named ports for the specified instance group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the instance group where the named ports are updated.

project string

Project ID for this request.

zone string

The name of the zone where the instance group is located.

resource compute(alpha).InstanceGroupsSetNamedPortsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceGroups.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4025

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.addAccessConfig(params, callback){object}

apis/compute/alpha.js, line 4214

Adds an access config to an instance's network interface.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

The instance name for this request.

networkInterface string

The name of the network interface to add to this instance.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).AccessConfig

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 4246

Retrieves aggregated list of instances.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.attachDisk(params, callback){object}

apis/compute/alpha.js, line 4277

Attaches a Disk resource to an instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

The instance name for this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).AttachedDisk

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.delete(params, callback){object}

apis/compute/alpha.js, line 4307

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance resource to delete.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.deleteAccessConfig(params, callback){object}

apis/compute/alpha.js, line 4339

Deletes an access config from an instance's network interface.

Name Type Description
params object

Parameters for request

Name Type Description
accessConfig string

The name of the access config to delete.

instance string

The instance name for this request.

networkInterface string

The name of the network interface.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.detachDisk(params, callback){object}

apis/compute/alpha.js, line 4370

Detaches a disk from an instance.

Name Type Description
params object

Parameters for request

Name Type Description
deviceName string

Disk device name to detach.

instance string

Instance name.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.get(params, callback){object}

apis/compute/alpha.js, line 4400

Returns the specified Instance resource. Get a list of available instances by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance resource to return.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 4430

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.getSerialPortOutput(params, callback){object}

apis/compute/alpha.js, line 4462

Returns the specified instance's serial port output.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

port integer optional

Specifies which COM or serial port to retrieve data from.

project string

Project ID for this request.

start string optional

For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.insert(params, callback){object}

apis/compute/alpha.js, line 4492

Creates an instance resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Instance

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.list(params, callback){object}

apis/compute/alpha.js, line 4525

Retrieves the list of instances contained within the specified zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.reset(params, callback){object}

apis/compute/alpha.js, line 4555

Performs a hard reset on the instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setDiskAutoDelete(params, callback){object}

apis/compute/alpha.js, line 4587

Sets the auto-delete flag for a disk attached to an instance.

Name Type Description
params object

Parameters for request

Name Type Description
autoDelete boolean

Whether to auto-delete the disk when the instance is deleted.

deviceName string

The device name of the disk to modify.

instance string

The instance name.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 4618

Sets the access control policy on the specified resource. Replaces any existing policy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Policy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setLabels(params, callback){object}

apis/compute/alpha.js, line 4649

Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).InstancesSetLabelsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setMachineType(params, callback){object}

apis/compute/alpha.js, line 4680

Changes the machine type for a stopped instance to the machine type specified in the request.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).InstancesSetMachineTypeRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setMetadata(params, callback){object}

apis/compute/alpha.js, line 4711

Sets metadata for the specified instance to the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Metadata

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setScheduling(params, callback){object}

apis/compute/alpha.js, line 4742

Sets an instance's scheduling options.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Instance name.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Scheduling

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setServiceAccount(params, callback){object}

apis/compute/alpha.js, line 4773

Sets the service account on the instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance resource to start.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).InstancesSetServiceAccountRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.setTags(params, callback){object}

apis/compute/alpha.js, line 4804

Sets tags for the specified instance to the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance scoping this request.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).Tags

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.start(params, callback){object}

apis/compute/alpha.js, line 4834

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance resource to start.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.startWithEncryptionKey(params, callback){object}

apis/compute/alpha.js, line 4865

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Name Type Description
params object

Parameters for request

Name Type Description
instance string

Name of the instance resource to start.

project string

Project ID for this request.

zone string

The name of the zone for this request.

resource compute(alpha).InstancesStartWithEncryptionKeyRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.stop(params, callback){object}

apis/compute/alpha.js, line 4896

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Name Type Description
params object

Parameters for request

Name Type Description
discardLocalSsd boolean optional

If true, discard the contents of any attached localSSD partitions. Default value is false.

instance string

Name of the instance resource to stop.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.suspend(params, callback){object}

apis/compute/alpha.js, line 4927

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

Name Type Description
params object

Parameters for request

Name Type Description
discardLocalSsd boolean optional

If true, discard the contents of any attached localSSD partitions. Default value is false.

instance string

Name of the instance resource to suspend.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instances.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4958

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceTemplates.delete(params, callback){object}

apis/compute/alpha.js, line 4058

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

Name Type Description
params object

Parameters for request

Name Type Description
instanceTemplate string

The name of the instance template to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceTemplates.get(params, callback){object}

apis/compute/alpha.js, line 4087

Returns the specified instance template. Get a list of available instance templates by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
instanceTemplate string

The name of the instance template.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceTemplates.insert(params, callback){object}

apis/compute/alpha.js, line 4116

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).InstanceTemplate

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceTemplates.list(params, callback){object}

apis/compute/alpha.js, line 4148

Retrieves a list of instance templates that are contained within the specified project and zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.instanceTemplates.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4178

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.licenses.get(params, callback){object}

apis/compute/alpha.js, line 4991

Returns the specified License resource. Get a list of available licenses by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
license string

Name of the License resource to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.machineTypes.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 5027

Retrieves an aggregated list of machine types.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.machineTypes.get(params, callback){object}

apis/compute/alpha.js, line 5057

Returns the specified machine type. Get a list of available machine types by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
machineType string

Name of the machine type to return.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.machineTypes.list(params, callback){object}

apis/compute/alpha.js, line 5090

Retrieves a list of machine types available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

The name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.delete(params, callback){object}

apis/compute/alpha.js, line 5123

Deletes the specified network.

Name Type Description
params object

Parameters for request

Name Type Description
network string

Name of the network to delete.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.get(params, callback){object}

apis/compute/alpha.js, line 5152

Returns the specified network. Get a list of available networks by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
network string

Name of the network to return.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.insert(params, callback){object}

apis/compute/alpha.js, line 5181

Creates a network in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Network

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.list(params, callback){object}

apis/compute/alpha.js, line 5213

Retrieves the list of networks available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.switchToCustomMode(params, callback){object}

apis/compute/alpha.js, line 5242

Switches the network mode from auto subnet mode to custom subnet mode.

Name Type Description
params object

Parameters for request

Name Type Description
network string

Name of the network to be updated.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.networks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 5272

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.disableXpnHost(params, callback){object}

apis/compute/alpha.js, line 5304

Disable this project as an XPN host project.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.disableXpnResource(params, callback){object}

apis/compute/alpha.js, line 5333

Disable an XPN resource associated with this host project.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).ProjectsDisableXpnResourceRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.enableXpnHost(params, callback){object}

apis/compute/alpha.js, line 5361

Enable this project as an XPN host project.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.enableXpnResource(params, callback){object}

apis/compute/alpha.js, line 5390

Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).ProjectsEnableXpnResourceRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.get(params, callback){object}

apis/compute/alpha.js, line 5418

Returns the specified Project resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.getXpnHost(params, callback){object}

apis/compute/alpha.js, line 5446

Get the XPN host project that this project links to. May be empty if no link exists.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.getXpnResources(params, callback){object}

apis/compute/alpha.js, line 5474

Get XPN resources associated with this host project.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.listXpnHosts(params, callback){object}

apis/compute/alpha.js, line 5503

List all XPN host projects visible to the user in an organization.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).ProjectsListXpnHostsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.moveDisk(params, callback){object}

apis/compute/alpha.js, line 5532

Moves a persistent disk from one zone to another.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).DiskMoveRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.moveInstance(params, callback){object}

apis/compute/alpha.js, line 5561

Moves an instance and its attached persistent disks from one zone to another.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).InstanceMoveRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.setCommonInstanceMetadata(params, callback){object}

apis/compute/alpha.js, line 5590

Sets metadata common to all instances within the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Metadata

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.projects.setUsageExportBucket(params, callback){object}

apis/compute/alpha.js, line 5619

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).UsageExportLocation

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.delete(params, callback){object}

apis/compute/alpha.js, line 5653

Deletes the specified autoscaler.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to delete.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.get(params, callback){object}

apis/compute/alpha.js, line 5683

Returns the specified autoscaler.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to return.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.insert(params, callback){object}

apis/compute/alpha.js, line 5713

Creates an autoscaler in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.list(params, callback){object}

apis/compute/alpha.js, line 5746

Retrieves a list of autoscalers contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.patch(params, callback){object}

apis/compute/alpha.js, line 5777

Updates a autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string

Name of the autoscaler to update.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 5808

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionAutoscalers.update(params, callback){object}

apis/compute/alpha.js, line 5839

Updates a autoscaler in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
autoscaler string optional

Name of the autoscaler to update.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).Autoscaler

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.delete(params, callback){object}

apis/compute/alpha.js, line 5873

Deletes the specified regional BackendService resource.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to delete.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.get(params, callback){object}

apis/compute/alpha.js, line 5903

Returns the specified regional BackendService resource.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to return.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.getHealth(params, callback){object}

apis/compute/alpha.js, line 5934

Gets the most recent health check results for this regional BackendService.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to which the queried instance belongs.

project string
region string

Name of the region scoping this request.

resource compute(alpha).ResourceGroupReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.insert(params, callback){object}

apis/compute/alpha.js, line 5964

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.list(params, callback){object}

apis/compute/alpha.js, line 5997

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.patch(params, callback){object}

apis/compute/alpha.js, line 6028

Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to update.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6059

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionBackendServices.update(params, callback){object}

apis/compute/alpha.js, line 6090

Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Name Type Description
params object

Parameters for request

Name Type Description
backendService string

Name of the BackendService resource to update.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).BackendService

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.createSnapshot(params, callback){object}

apis/compute/alpha.js, line 6193

Creates a snapshot of this regional disk.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the regional persistent disk to snapshot.

guestFlush boolean optional
project string

Project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).Snapshot

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.delete(params, callback){object}

apis/compute/alpha.js, line 6223

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the regional persistent disk to delete.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.get(params, callback){object}

apis/compute/alpha.js, line 6253

Returns a specified regional persistent disk.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the regional persistent disk to return.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.insert(params, callback){object}

apis/compute/alpha.js, line 6284

Creates a persistent regional disk in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

sourceImage string optional

Optional. Source image to restore onto a disk.

resource compute(alpha).Disk

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.list(params, callback){object}

apis/compute/alpha.js, line 6317

Retrieves the list of persistent disks contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.resize(params, callback){object}

apis/compute/alpha.js, line 6348

Resizes the specified regional persistent disk.

Name Type Description
params object

Parameters for request

Name Type Description
disk string

Name of the regional persistent disk.

project string

The project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).RegionDisksResizeRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.setLabels(params, callback){object}

apis/compute/alpha.js, line 6379

Sets the labels on the target regional disk.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).RegionSetLabelsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDisks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6410

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDiskTypes.get(params, callback){object}

apis/compute/alpha.js, line 6124

Returns the specified regional disk type. Get a list of available disk types by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
diskType string

Name of the disk type to return.

project string

Project ID for this request.

region string

The name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionDiskTypes.list(params, callback){object}

apis/compute/alpha.js, line 6157

Retrieves a list of regional disk types available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

The name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.abandonInstances(params, callback){object}

apis/compute/alpha.js, line 6445

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersAbandonInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.delete(params, callback){object}

apis/compute/alpha.js, line 6475

Deletes the specified managed instance group and all of the instances in that group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group to delete.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.deleteInstances(params, callback){object}

apis/compute/alpha.js, line 6506

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersDeleteInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.get(params, callback){object}

apis/compute/alpha.js, line 6536

Returns all of the details for the specified managed instance group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group to return.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.insert(params, callback){object}

apis/compute/alpha.js, line 6566

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).InstanceGroupManager

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.list(params, callback){object}

apis/compute/alpha.js, line 6599

Retrieves the list of managed instance groups that are contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.listManagedInstances(params, callback){object}

apis/compute/alpha.js, line 6629

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.recreateInstances(params, callback){object}

apis/compute/alpha.js, line 6660

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersRecreateRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.resize(params, callback){object}

apis/compute/alpha.js, line 6691

Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

size integer

Number of instances that should exist in this instance group manager.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setAutoHealingPolicies(params, callback){object}

apis/compute/alpha.js, line 6722

Modifies the autohealing policy for the instances in this managed instance group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersSetAutoHealingRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setInstanceTemplate(params, callback){object}

apis/compute/alpha.js, line 6753

Sets the instance template to use when creating new instances in this group. Existing instances are not affected.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

The name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersSetTemplateRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setTargetPools(params, callback){object}

apis/compute/alpha.js, line 6784

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroupManager string

Name of the managed instance group.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupManagersSetTargetPoolsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6815

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroups.get(params, callback){object}

apis/compute/alpha.js, line 6849

Returns the specified instance group resource.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

Name of the instance group resource to return.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroups.list(params, callback){object}

apis/compute/alpha.js, line 6882

Retrieves the list of instance group resources contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroups.listInstances(params, callback){object}

apis/compute/alpha.js, line 6917

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

instanceGroup string

Name of the regional instance group for which we want to list the instances.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupsListInstancesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroups.setNamedPorts(params, callback){object}

apis/compute/alpha.js, line 6948

Sets the named ports for the specified regional instance group.

Name Type Description
params object

Parameters for request

Name Type Description
instanceGroup string

The name of the regional instance group where the named ports are updated.

project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).RegionInstanceGroupsSetNamedPortsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionInstanceGroups.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6979

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionOperations.delete(params, callback){object}

apis/compute/alpha.js, line 7013

Deletes the specified region-specific Operations resource.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to delete.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionOperations.get(params, callback){object}

apis/compute/alpha.js, line 7043

Retrieves the specified region-specific Operations resource.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to return.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regionOperations.list(params, callback){object}

apis/compute/alpha.js, line 7076

Retrieves a list of Operation resources contained within the specified region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regions.get(params, callback){object}

apis/compute/alpha.js, line 7109

Returns the specified Region resource. Get a list of available regions by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.regions.list(params, callback){object}

apis/compute/alpha.js, line 7141

Retrieves the list of region resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 7177

Retrieves an aggregated list of routers.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.delete(params, callback){object}

apis/compute/alpha.js, line 7207

Deletes the specified Router resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.get(params, callback){object}

apis/compute/alpha.js, line 7237

Returns the specified Router resource. Get a list of available routers by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.getRouterStatus(params, callback){object}

apis/compute/alpha.js, line 7267

Retrieves runtime information of the specified router.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to query.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.insert(params, callback){object}

apis/compute/alpha.js, line 7297

Creates a Router resource in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).Router

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.list(params, callback){object}

apis/compute/alpha.js, line 7330

Retrieves a list of Router resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.patch(params, callback){object}

apis/compute/alpha.js, line 7361

Updates the entire content of the Router resource. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to update.

resource compute(alpha).Router

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.preview(params, callback){object}

apis/compute/alpha.js, line 7392

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to query.

resource compute(alpha).Router

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7423

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routers.update(params, callback){object}

apis/compute/alpha.js, line 7454

Updates the entire content of the Router resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

router string

Name of the Router resource to update.

resource compute(alpha).Router

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routes.delete(params, callback){object}

apis/compute/alpha.js, line 7487

Deletes the specified Route resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

route string

Name of the Route resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routes.get(params, callback){object}

apis/compute/alpha.js, line 7516

Returns the specified Route resource. Get a list of available routes by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

route string

Name of the Route resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routes.insert(params, callback){object}

apis/compute/alpha.js, line 7545

Creates a Route resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).Route

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routes.list(params, callback){object}

apis/compute/alpha.js, line 7577

Retrieves the list of Route resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.routes.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7607

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.snapshots.delete(params, callback){object}

apis/compute/alpha.js, line 7640

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snaphots.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

snapshot string

Name of the Snapshot resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.snapshots.get(params, callback){object}

apis/compute/alpha.js, line 7669

Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

snapshot string

Name of the Snapshot resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.snapshots.list(params, callback){object}

apis/compute/alpha.js, line 7701

Retrieves the list of Snapshot resources contained within the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.snapshots.setLabels(params, callback){object}

apis/compute/alpha.js, line 7731

Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).GlobalSetLabelsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.snapshots.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7761

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.sslCertificates.delete(params, callback){object}

apis/compute/alpha.js, line 7794

Deletes the specified SslCertificate resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

sslCertificate string

Name of the SslCertificate resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.sslCertificates.get(params, callback){object}

apis/compute/alpha.js, line 7823

Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

sslCertificate string

Name of the SslCertificate resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.sslCertificates.insert(params, callback){object}

apis/compute/alpha.js, line 7852

Creates a SslCertificate resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).SslCertificate

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.sslCertificates.list(params, callback){object}

apis/compute/alpha.js, line 7884

Retrieves the list of SslCertificate resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.sslCertificates.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7914

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 7950

Retrieves an aggregated list of subnetworks.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.delete(params, callback){object}

apis/compute/alpha.js, line 7980

Deletes the specified subnetwork.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

subnetwork string

Name of the Subnetwork resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.expandIpCidrRange(params, callback){object}

apis/compute/alpha.js, line 8011

Expands the IP CIDR range of the subnetwork to a specified value.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

subnetwork string

Name of the Subnetwork resource to update.

resource compute(alpha).SubnetworksExpandIpCidrRangeRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.get(params, callback){object}

apis/compute/alpha.js, line 8041

Returns the specified subnetwork. Get a list of available subnetworks list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

subnetwork string

Name of the Subnetwork resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 8071

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.insert(params, callback){object}

apis/compute/alpha.js, line 8101

Creates a subnetwork in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).Subnetwork

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.list(params, callback){object}

apis/compute/alpha.js, line 8134

Retrieves a list of subnetworks available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 8165

Sets the access control policy on the specified resource. Replaces any existing policy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).Policy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.subnetworks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8196

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.delete(params, callback){object}

apis/compute/alpha.js, line 8229

Deletes the specified TargetHttpProxy resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpProxy string

Name of the TargetHttpProxy resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.get(params, callback){object}

apis/compute/alpha.js, line 8258

Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpProxy string

Name of the TargetHttpProxy resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.insert(params, callback){object}

apis/compute/alpha.js, line 8287

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).TargetHttpProxy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.list(params, callback){object}

apis/compute/alpha.js, line 8319

Retrieves the list of TargetHttpProxy resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.setUrlMap(params, callback){object}

apis/compute/alpha.js, line 8349

Changes the URL map for TargetHttpProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpProxy string

Name of the TargetHttpProxy to set a URL map for.

resource compute(alpha).UrlMapReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8379

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.delete(params, callback){object}

apis/compute/alpha.js, line 8412

Deletes the specified TargetHttpsProxy resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpsProxy string

Name of the TargetHttpsProxy resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.get(params, callback){object}

apis/compute/alpha.js, line 8441

Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpsProxy string

Name of the TargetHttpsProxy resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.insert(params, callback){object}

apis/compute/alpha.js, line 8470

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).TargetHttpsProxy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.list(params, callback){object}

apis/compute/alpha.js, line 8502

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.setSslCertificates(params, callback){object}

apis/compute/alpha.js, line 8532

Replaces SslCertificates for TargetHttpsProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpsProxy string

Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

resource compute(alpha).TargetHttpsProxiesSetSslCertificatesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.setUrlMap(params, callback){object}

apis/compute/alpha.js, line 8562

Changes the URL map for TargetHttpsProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetHttpsProxy string

Name of the TargetHttpsProxy resource whose URL map is to be set.

resource compute(alpha).UrlMapReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetHttpsProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8592

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 8628

Retrieves an aggregated list of target instances.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.delete(params, callback){object}

apis/compute/alpha.js, line 8658

Deletes the specified TargetInstance resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetInstance string

Name of the TargetInstance resource to delete.

zone string

Name of the zone scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.get(params, callback){object}

apis/compute/alpha.js, line 8688

Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetInstance string

Name of the TargetInstance resource to return.

zone string

Name of the zone scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.insert(params, callback){object}

apis/compute/alpha.js, line 8718

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

Name of the zone scoping this request.

resource compute(alpha).TargetInstance

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.list(params, callback){object}

apis/compute/alpha.js, line 8751

Retrieves a list of TargetInstance resources available to the specified project and zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

Name of the zone scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetInstances.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8782

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

zone string

The name of the zone for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.addHealthCheck(params, callback){object}

apis/compute/alpha.js, line 8817

Adds health check URLs to a target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the target pool to add a health check to.

resource compute(alpha).TargetPoolsAddHealthCheckRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.addInstance(params, callback){object}

apis/compute/alpha.js, line 8848

Adds an instance to a target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to add instances to.

resource compute(alpha).TargetPoolsAddInstanceRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 8880

Retrieves an aggregated list of target pools.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.delete(params, callback){object}

apis/compute/alpha.js, line 8910

Deletes the specified target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.get(params, callback){object}

apis/compute/alpha.js, line 8940

Returns the specified target pool. Get a list of available target pools by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.getHealth(params, callback){object}

apis/compute/alpha.js, line 8971

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to which the queried instance belongs.

resource compute(alpha).InstanceReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.insert(params, callback){object}

apis/compute/alpha.js, line 9001

Creates a target pool in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

resource compute(alpha).TargetPool

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.list(params, callback){object}

apis/compute/alpha.js, line 9034

Retrieves a list of target pools available to the specified project and region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region scoping this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.removeHealthCheck(params, callback){object}

apis/compute/alpha.js, line 9065

Removes health check URL from a target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetPool string

Name of the target pool to remove health checks from.

resource compute(alpha).TargetPoolsRemoveHealthCheckRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.removeInstance(params, callback){object}

apis/compute/alpha.js, line 9096

Removes instance URL from a target pool.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to remove instances from.

resource compute(alpha).TargetPoolsRemoveInstanceRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.setBackup(params, callback){object}

apis/compute/alpha.js, line 9128

Changes a backup target pool's configurations.

Name Type Description
params object

Parameters for request

Name Type Description
failoverRatio number optional

New failoverRatio value for the target pool.

project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to set a backup pool for.

resource compute(alpha).TargetReference

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetPools.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9159

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.delete(params, callback){object}

apis/compute/alpha.js, line 9192

Deletes the specified TargetSslProxy resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetSslProxy string

Name of the TargetSslProxy resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.get(params, callback){object}

apis/compute/alpha.js, line 9221

Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetSslProxy string

Name of the TargetSslProxy resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.insert(params, callback){object}

apis/compute/alpha.js, line 9250

Creates a TargetSslProxy resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).TargetSslProxy

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.list(params, callback){object}

apis/compute/alpha.js, line 9282

Retrieves the list of TargetSslProxy resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.setBackendService(params, callback){object}

apis/compute/alpha.js, line 9312

Changes the BackendService for TargetSslProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetSslProxy string

Name of the TargetSslProxy resource whose BackendService resource is to be set.

resource compute(alpha).TargetSslProxiesSetBackendServiceRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.setProxyHeader(params, callback){object}

apis/compute/alpha.js, line 9342

Changes the ProxyHeaderType for TargetSslProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetSslProxy string

Name of the TargetSslProxy resource whose ProxyHeader is to be set.

resource compute(alpha).TargetSslProxiesSetProxyHeaderRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.setSslCertificates(params, callback){object}

apis/compute/alpha.js, line 9372

Changes SslCertificates for TargetSslProxy.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

targetSslProxy string

Name of the TargetSslProxy resource whose SslCertificate resource is to be set.

resource compute(alpha).TargetSslProxiesSetSslCertificatesRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetSslProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9402

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 9438

Retrieves an aggregated list of target VPN gateways.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.delete(params, callback){object}

apis/compute/alpha.js, line 9468

Deletes the specified target VPN gateway.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetVpnGateway string

Name of the target VPN gateway to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.get(params, callback){object}

apis/compute/alpha.js, line 9498

Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

targetVpnGateway string

Name of the target VPN gateway to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.insert(params, callback){object}

apis/compute/alpha.js, line 9528

Creates a target VPN gateway in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).TargetVpnGateway

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.list(params, callback){object}

apis/compute/alpha.js, line 9561

Retrieves a list of target VPN gateways available to the specified project and region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.targetVpnGateways.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9592

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.delete(params, callback){object}

apis/compute/alpha.js, line 9625

Deletes the specified UrlMap resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.get(params, callback){object}

apis/compute/alpha.js, line 9654

Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.insert(params, callback){object}

apis/compute/alpha.js, line 9683

Creates a UrlMap resource in the specified project using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource compute(alpha).UrlMap

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.invalidateCache(params, callback){object}

apis/compute/alpha.js, line 9713

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap scoping this request.

resource compute(alpha).CacheInvalidationRule

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.list(params, callback){object}

apis/compute/alpha.js, line 9745

Retrieves the list of UrlMap resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.patch(params, callback){object}

apis/compute/alpha.js, line 9775

Updates the entire content of the UrlMap resource. This method supports patch semantics.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to update.

resource compute(alpha).UrlMap

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9805

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.update(params, callback){object}

apis/compute/alpha.js, line 9835

Updates the entire content of the UrlMap resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to update.

resource compute(alpha).UrlMap

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.urlMaps.validate(params, callback){object}

apis/compute/alpha.js, line 9865

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to be validated as.

resource compute(alpha).UrlMapsValidateRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 9901

Retrieves an aggregated list of VPN tunnels.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.delete(params, callback){object}

apis/compute/alpha.js, line 9931

Deletes the specified VpnTunnel resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

vpnTunnel string

Name of the VpnTunnel resource to delete.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.get(params, callback){object}

apis/compute/alpha.js, line 9961

Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

vpnTunnel string

Name of the VpnTunnel resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.insert(params, callback){object}

apis/compute/alpha.js, line 9991

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

Name of the region for this request.

resource compute(alpha).VpnTunnel

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.list(params, callback){object}

apis/compute/alpha.js, line 10024

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

region string

Name of the region for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.vpnTunnels.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 10055

Returns permissions that a caller has on the specified resource.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

region string

The name of the region for this request.

resource_ string

Name of the resource for this request.

resource compute(alpha).TestPermissionsRequest

Request body data

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.zoneOperations.delete(params, callback){object}

apis/compute/alpha.js, line 10089

Deletes the specified zone-specific Operations resource.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to delete.

project string

Project ID for this request.

zone string

Name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.zoneOperations.get(params, callback){object}

apis/compute/alpha.js, line 10119

Retrieves the specified zone-specific Operations resource.

Name Type Description
params object

Parameters for request

Name Type Description
operation string

Name of the Operations resource to return.

project string

Project ID for this request.

zone string

Name of the zone for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.zoneOperations.list(params, callback){object}

apis/compute/alpha.js, line 10152

Retrieves a list of Operation resources contained within the specified zone.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

zone string

Name of the zone for request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.zones.get(params, callback){object}

apis/compute/alpha.js, line 10185

Returns the specified Zone resource. Get a list of available zones by making a list() request.

Name Type Description
params object

Parameters for request

Name Type Description
project string

Project ID for this request.

zone string

Name of the zone resource to return.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

staticcompute(alpha).compute.zones.list(params, callback){object}

apis/compute/alpha.js, line 10217

Retrieves the list of Zone resources available to the specified project.

Name Type Description
params object

Parameters for request

Name Type Description
filter string optional

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

maxResults integer optional

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

orderBy string optional

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

pageToken string optional

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project string

Project ID for this request.

callback callback

The callback that handles the response.

Returns:
Type Description
object Request object

Type Definitions

compute(alpha).AccessConfigobject

Properties:
Name Type Description
kind string

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

name string

Name of this access configuration.

natIP string

An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

type string

The type of configuration. The default and only option is ONE_TO_ONE_NAT.

compute(alpha).Addressobject

Properties:
Name Type Description
address string

The static external IP address represented by this resource.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#address for addresses.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region string

[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.

selfLink string

[Output Only] Server-defined URL for the resource.

status string

[Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

users Array.<string>

[Output Only] The URLs of the resources that are using this address.

compute(alpha).AddressAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items object

[Output Only] A map of scoped address lists.

kind string

[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).AddressesScopedListobject

Properties:
Name Type Description
addresses Array.<compute(alpha).Address>

[Output Only] List of addresses contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

compute(alpha).AddressListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Address>

[Output Only] A list of addresses.

kind string

[Output Only] Type of resource. Always compute#addressList for lists of addresses.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).AttachedDiskobject

Properties:
Name Type Description
autoDelete boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

boot boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

deviceName string

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

diskEncryptionKey compute(alpha).CustomerEncryptionKey

Encrypts or decrypts a disk using a customer-supplied encryption key.

If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

index integer

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

initializeParams compute(alpha).AttachedDiskInitializeParams

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.

interface string

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

kind string

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

licenses Array.<string>

[Output Only] Any valid publicly visible licenses.

mode string

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

source string

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.

type string

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

compute(alpha).AttachedDiskInitializeParamsobject

Properties:
Name Type Description
diskName string

Specifies the disk name. If not specified, the default is to use the name of the instance.

diskSizeGb string

Specifies the size of the disk in base-2 GB.

diskStorageType string

[Deprecated] Storage type of the disk.

diskType string

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
  • projects/project/zones/zone/diskTypes/diskType
  • zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
sourceImage string

The source image used to create this disk. If the source image is deleted, this field will not be set.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-private-family

sourceImageEncryptionKey compute(alpha).CustomerEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

compute(alpha).AuditConfigobject

Properties:
Name Type Description
exemptedMembers Array.<string>

Specifies the identities that are exempted from "data access" audit logging for the service specified above. Follows the same format of Binding.members.

service string

Specifies a service that will be enabled for "data access" audit logging. For example, resourcemanager, storage, compute. allServices is a special value that covers all services.

compute(alpha).Autoscalerobject

Properties:
Name Type Description
autoscalingPolicy compute(alpha).AutoscalingPolicy

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.8 or 80%.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region string

[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).

selfLink string

[Output Only] Server-defined URL for the resource.

status string

[Output Only] The status of the autoscaler configuration.

statusDetails Array.<compute(alpha).AutoscalerStatusDetails>

[Output Only] Human-readable details about the current state of the autoscaler. Examples: ?Error when fetching replicas: Replica Pool xxx doesn?t exist.? ?Autoscaling capped at min_num_replicas: 2.?

target string

URL of the managed instance group that this autoscaler will scale.

zone string

[Output Only] URL of the zone where the instance group resides.

compute(alpha).AutoscalerAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

A map of scoped autoscaler lists.

kind string

[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).AutoscalerListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Autoscaler>

A list of Autoscaler resources.

kind string

[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).AutoscalersScopedListobject

Properties:
Name Type Description
autoscalers Array.<compute(alpha).Autoscaler>

[Output Only] List of autoscalers contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.

compute(alpha).AutoscalerStatusDetailsobject

Properties:
Name Type Description
message string
type string

compute(alpha).AutoscalingPolicyobject

Properties:
Name Type Description
coolDownPeriodSec integer

The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

cpuUtilization compute(alpha).AutoscalingPolicyCpuUtilization

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

customMetricUtilizations Array.<compute(alpha).AutoscalingPolicyCustomMetricUtilization>

Configuration parameters of autoscaling based on a custom metric.

loadBalancingUtilization compute(alpha).AutoscalingPolicyLoadBalancingUtilization

Configuration parameters of autoscaling based on load balancer.

maxNumReplicas integer

The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

minNumReplicas integer

The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

queueBasedScaling compute(alpha).AutoscalingPolicyQueueBasedScaling

Configuration parameters of autoscaling based on queuing system.

compute(alpha).AutoscalingPolicyCpuUtilizationobject

Properties:
Name Type Description
utilizationTarget number

The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.8.

If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.

compute(alpha).AutoscalingPolicyCustomMetricUtilizationobject

Properties:
Name Type Description
metric string

The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.

For example, the following is a valid metric: compute.googleapis.com/instance/network/received_bytes_count

The following is not a valid metric because it does not increase or decrease based on usage: compute.googleapis.com/instance/cpu/reserved_cores

utilizationTarget number

Target value of the metric which autoscaler should maintain. Must be a positive value.

utilizationTargetType string

Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.

compute(alpha).AutoscalingPolicyLoadBalancingUtilizationobject

Properties:
Name Type Description
utilizationTarget number

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

compute(alpha).AutoscalingPolicyQueueBasedScalingobject

Properties:
Name Type Description
acceptableBacklogPerInstance number

Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.

cloudPubSub compute(alpha).AutoscalingPolicyQueueBasedScalingCloudPubSub

Configuration for Cloud Pub/Sub subscription queue.

singleWorkerThroughputPerSec number

The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.

compute(alpha).AutoscalingPolicyQueueBasedScalingCloudPubSubobject

Properties:
Name Type Description
subscription string

Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.

topic string

Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.

compute(alpha).Backendobject

Properties:
Name Type Description
balancingMode string

Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.

This cannot be used for internal load balancing.

capacityScaler number

A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].

This cannot be used for internal load balancing.

description string

An optional description of this resource. Provide this property when you create the resource.

group string

The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.

maxConnections integer

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

maxConnectionsPerInstance integer

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

maxRate integer

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

maxRatePerInstance number

The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

maxUtilization number

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].

This cannot be used for internal load balancing.

compute(alpha).BackendBucketobject

Properties:
Name Type Description
bucketName string

Cloud Storage bucket name.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional textual description of the resource; provided by the client when the resource is created.

enableCdn boolean

If true, enable Cloud CDN for this BackendBucket.

id string

[Output Only] Unique identifier for the resource; defined by the server.

kind string

Type of the resource.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).BackendBucketListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items Array.<compute(alpha).BackendBucket>

A list of BackendBucket resources.

kind string

Type of resource.

nextPageToken string

[Output Only] A token used to continue a truncated list request.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).BackendServiceobject

Properties:
Name Type Description
affinityCookieTtlSec integer

Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.

When the load balancing scheme is INTERNAL, this field is not used.

backendSslPolicy compute(alpha).BackendSSLPolicy

Backend SSL policies to enforce.

backends Array.<compute(alpha).Backend>

The list of backends that serve this BackendService.

connectionDraining compute(alpha).ConnectionDraining
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

enableCDN boolean

If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.

fingerprint string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.

healthChecks Array.<string>

The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

For internal load balancing, a URL to a HealthCheck resource must be specified instead.

iaap compute(alpha).BackendServiceIAAP
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of resource. Always compute#backendService for backend services.

loadBalancingScheme string
name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

port integer

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

This cannot be used for internal load balancing.

portName string

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

When the load balancing scheme is INTERNAL, this field is not used.

protocol string

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.

For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

region string

[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.

selfLink string

[Output Only] Server-defined URL for the resource.

sessionAffinity string

Type of session affinity to use. The default is NONE.

When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.

When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the protocol is UDP, this field is not used.

timeoutSec integer

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.

compute(alpha).BackendServiceGroupHealthobject

Properties:
Name Type Description
healthStatus Array.<compute(alpha).HealthStatus>
kind string

[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.

compute(alpha).BackendServiceIAAPobject

Properties:
Name Type Description
enabled boolean
oauth2ClientId string
oauth2ClientSecret string
oauth2ClientSecretSha256 string

compute(alpha).BackendServiceListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items Array.<compute(alpha).BackendService>

A list of BackendService resources.

kind string

[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.

nextPageToken string

[Output Only] A token used to continue a truncated list request.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).BackendSSLPolicyobject

Properties:
Name Type Description
pinnedPeerCertificates Array.<string>

List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.

compute(alpha).Bindingobject

Properties:
Name Type Description
members Array.<string>

Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.

role string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

compute(alpha).CacheInvalidationRuleobject

Properties:
Name Type Description
host string

If host is non-empty, this invalidation rule will only apply to requests with a Host header matching host.

path string

compute(alpha).Conditionobject

Properties:
Name Type Description
iam string

Trusted attributes supplied by the IAM system.

op string

An operator to apply the subject with.

svc string

Trusted attributes discharged by the service.

sys string

Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

value string

DEPRECATED. Use 'values' instead.

values Array.<string>

The objects of the condition. This is mutually exclusive with 'value'.

compute(alpha).ConnectionDrainingobject

Properties:
Name Type Description
drainingTimeoutSec integer

Time for which instance will be drained (not accept new connections, but still work to finish started).

compute(alpha).CustomerEncryptionKeyobject

Properties:
Name Type Description
rawKey string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

rsaEncryptedKey string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  • The key is wrapped using a RSA public key certificate provided by Google.
  • After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sha256 string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

compute(alpha).CustomerEncryptionKeyProtectedDiskobject

Properties:
Name Type Description
diskEncryptionKey compute(alpha).CustomerEncryptionKey

Decrypts data associated with the disk with a customer-supplied encryption key.

source string

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

compute(alpha).DeprecationStatusobject

Properties:
Name Type Description
deleted string

An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.

deprecated string

An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.

obsolete string

An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.

replacement string

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

state string

The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

compute(alpha).Diskobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

diskEncryptionKey compute(alpha).CustomerEncryptionKey

Encrypts the disk using a customer-supplied encryption key.

After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#disk for disks.

labelFingerprint string

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve a disk.

labels object

Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

lastAttachTimestamp string

[Output Only] Last attach timestamp in RFC3339 text format.

lastDetachTimestamp string

[Output Only] Last detach timestamp in RFC3339 text format.

licenses Array.<string>

Any applicable publicly visible licenses.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

options string

Internal use only.

region string

[Output Only] URL of the region where the disk resides. Only applicable for regional resources.

replicaZones Array.<string>

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

selfLink string

[Output Only] Server-defined fully-qualified URL for this resource.

sizeGb string

Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.

If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.

sourceImage string

The source image used to create this disk. If the source image is deleted, this field will not be set.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-private-family

sourceImageEncryptionKey compute(alpha).CustomerEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

sourceImageId string

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

sourceSnapshot string

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
  • projects/project/global/snapshots/snapshot
  • global/snapshots/snapshot
sourceSnapshotEncryptionKey compute(alpha).CustomerEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

sourceSnapshotId string

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

status string

[Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.

storageType string

[Deprecated] Storage type of the persistent disk.

type string

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.

users Array.<string>

[Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance

zone string

[Output Only] URL of the zone where the disk resides.

compute(alpha).DiskAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped disk lists.

kind string

[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).DiskListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Disk>

[Output Only] A list of persistent disks.

kind string

[Output Only] Type of resource. Always compute#diskList for lists of disks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).DiskMoveRequestobject

Properties:
Name Type Description
destinationZone string

The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone
  • projects/project/zones/zone
  • zones/zone
targetDisk string

The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
  • projects/project/zones/zone/disks/disk
  • zones/zone/disks/disk

compute(alpha).DisksResizeRequestobject

Properties:
Name Type Description
sizeGb string

The new size of the persistent disk, which is specified in GB.

compute(alpha).DisksScopedListobject

Properties:
Name Type Description
disks Array.<compute(alpha).Disk>

[Output Only] List of disks contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of disks when the list is empty.

compute(alpha).DiskTypeobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

defaultDiskSizeGb string

[Output Only] Server-defined default disk size in GB.

deprecated compute(alpha).DeprecationStatus

[Output Only] The deprecation status associated with this disk type.

description string

[Output Only] An optional description of this resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#diskType for disk types.

name string

[Output Only] Name of the resource.

selfLink string

[Output Only] Server-defined URL for the resource.

validDiskSize string

[Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".

zone string

[Output Only] URL of the zone where the disk type resides.

compute(alpha).DiskTypeAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped disk type lists.

kind string

[Output Only] Type of resource. Always compute#diskTypeAggregatedList.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).DiskTypeListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).DiskType>

[Output Only] A list of Disk Type resources.

kind string

[Output Only] Type of resource. Always compute#diskTypeList for disk types.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).DiskTypesScopedListobject

Properties:
Name Type Description
diskTypes Array.<compute(alpha).DiskType>

[Output Only] List of disk types contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of disk types when the list is empty.

compute(alpha).Firewallobject

Properties:
Name Type Description
allowed Array.<object>

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Ony] Type of the resource. Always compute#firewall for firewall rules.

name string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
  • projects/myproject/global/networks/my-network
  • global/networks/default
selfLink string

[Output Only] Server-defined URL for the resource.

sourceRanges Array.<string>

If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.

sourceTags Array.<string>

If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.

targetTags Array.<string>

A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

compute(alpha).FirewallListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Firewall>

[Output Only] A list of Firewall resources.

kind string

[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).FixedOrPercentobject

Properties:
Name Type Description
calculated integer

[Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)

fixed integer

fixed must be non-negative.

percent integer

percent must belong to [0, 100].

compute(alpha).ForwardingRuleobject

Properties:
Name Type Description
IPAddress string

The IP address that this forwarding rule is serving on behalf of.

For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.

When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.

IPProtocol string

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.

When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.

backendService string

This field is not used for external load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

loadBalancingScheme string

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)

name string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

This field is not used for external load balancing.

For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.

portRange string

Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

This field is not used for internal load balancing.

ports Array.<string>

This field is not used for external load balancing.

When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.

You may specify a maximum of up to 5 ports.

region string

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

selfLink string

[Output Only] Server-defined URL for the resource.

subnetwork string

This field is not used for external load balancing.

For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.

If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.

target string

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.

This field is not used for internal load balancing.

compute(alpha).ForwardingRuleAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

A map of scoped forwarding rule lists.

kind string

[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).ForwardingRuleListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Set by the server.

items Array.<compute(alpha).ForwardingRule>

A list of ForwardingRule resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).ForwardingRulesScopedListobject

Properties:
Name Type Description
forwardingRules Array.<compute(alpha).ForwardingRule>

List of forwarding rules contained in this scope.

warning object

Informational warning which replaces the list of forwarding rules when the list is empty.

compute(alpha).GlobalSetLabelsRequestobject

Properties:
Name Type Description
labelFingerprint string

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

labels object

A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

compute(alpha).GuestOsFeatureobject

Properties:
Name Type Description
type string

The type of supported feature..

compute(alpha).HealthCheckobject

Properties:
Name Type Description
checkIntervalSec integer

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp string

[Output Only] Creation timestamp in 3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

http2HealthCheck compute(alpha).HTTP2HealthCheck
httpHealthCheck compute(alpha).HTTPHealthCheck
httpsHealthCheck compute(alpha).HTTPSHealthCheck
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

Type of the resource.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

sslHealthCheck compute(alpha).SSLHealthCheck
tcpHealthCheck compute(alpha).TCPHealthCheck
timeoutSec integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

type string

Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

unhealthyThreshold integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

compute(alpha).HealthCheckListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).HealthCheck>

A list of HealthCheck resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).HealthCheckReferenceobject

Properties:
Name Type Description
healthCheck string

compute(alpha).HealthStatusobject

Properties:
Name Type Description
healthState string

Health state of the instance.

instance string

URL of the instance resource.

ipAddress string

The IP address represented by this resource.

port integer

The port on the instance.

compute(alpha).HostRuleobject

Properties:
Name Type Description
description string

An optional description of this resource. Provide this property when you create the resource.

hosts Array.<string>

The list of host patterns to match. They must be valid hostnames, except will match any string of ([a-z0-9-.]). In that case, * must be the first character and must be followed in the pattern by either - or ..

pathMatcher string

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

compute(alpha).HTTP2HealthCheckobject

Properties:
Name Type Description
host string

The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

port integer

The TCP port number for the health check request. The default value is 443.

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

requestPath string

The request path of the HTTP/2 health check request. The default value is /.

compute(alpha).HttpHealthCheckobject

Properties:
Name Type Description
checkIntervalSec integer

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

host string

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

port integer

The TCP port number for the HTTP health check request. The default value is 80.

requestPath string

The request path of the HTTP health check request. The default value is /.

selfLink string

[Output Only] Server-defined URL for the resource.

timeoutSec integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

unhealthyThreshold integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

compute(alpha).HTTPHealthCheckobject

Properties:
Name Type Description
host string

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

port integer

The TCP port number for the health check request. The default value is 80.

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

requestPath string

The request path of the HTTP health check request. The default value is /.

compute(alpha).HttpHealthCheckListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items Array.<compute(alpha).HttpHealthCheck>

A list of HttpHealthCheck resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).HTTPSHealthCheckobject

Properties:
Name Type Description
host string

The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

port integer

The TCP port number for the health check request. The default value is 443.

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

requestPath string

The request path of the HTTPS health check request. The default value is /.

compute(alpha).HttpsHealthCheckobject

Properties:
Name Type Description
checkIntervalSec integer

How often (in seconds) to send a health check. The default value is 5 seconds.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

host string

The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

Type of the resource.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

port integer

The TCP port number for the HTTPS health check request. The default value is 443.

requestPath string

The request path of the HTTPS health check request. The default value is "/".

selfLink string

[Output Only] Server-defined URL for the resource.

timeoutSec integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.

unhealthyThreshold integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

compute(alpha).HttpsHealthCheckListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items Array.<compute(alpha).HttpsHealthCheck>

A list of HttpsHealthCheck resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).Imageobject

Properties:
Name Type Description
archiveSizeBytes string

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated compute(alpha).DeprecationStatus

The deprecation status associated with this image.

description string

An optional description of this resource. Provide this property when you create the resource.

diskSizeGb string

Size of the image when restored onto a persistent disk (in GB).

family string

The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

guestOsFeatures Array.<compute(alpha).GuestOsFeature>

Features of the guest os, valid for bootable images only.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

imageEncryptionKey compute(alpha).CustomerEncryptionKey

Encrypts the image using a customer-supplied encryption key.

After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

kind string

[Output Only] Type of the resource. Always compute#image for images.

labelFingerprint string

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve an image.

labels object

Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

licenses Array.<string>

Any applicable license URI.

name string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

rawDisk object

The parameters of the raw disk image.

selfLink string

[Output Only] Server-defined URL for the resource.

sourceDisk string

URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
  • projects/project/zones/zone/disk/disk
  • zones/zone/disks/disk
sourceDiskEncryptionKey compute(alpha).CustomerEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

sourceDiskId string

The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

sourceType string

The type of the image used to create this disk. The default and only value is RAW

status string

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

compute(alpha).ImageListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Image>

[Output Only] A list of Image resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).Instanceobject

Properties:
Name Type Description
canIpForward boolean

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

cpuPlatform string

[Output Only] The CPU platform used by this instance.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

disks Array.<compute(alpha).AttachedDisk>

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instanceEncryptionKey compute(alpha).CustomerEncryptionKey

Encrypts or decrypts data for an instance with a customer-supplied encryption key.

If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

kind string

[Output Only] Type of the resource. Always compute#instance for instances.

labelFingerprint string

A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

To see the latest fingerprint, make get() request to the instance.

labels object

Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

machineType string

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

zones/us-central1-f/machineTypes/n1-standard-1

To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

zones/zone/machineTypes/custom-CPUS-MEMORY

For example: zones/us-central1-f/machineTypes/custom-4-5120

For a full list of restrictions, read the Specifications for custom machine types.

metadata compute(alpha).Metadata

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

name string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

networkInterfaces Array.<compute(alpha).NetworkInterface>

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.

scheduling compute(alpha).Scheduling

Scheduling options for this instance.

selfLink string

[Output Only] Server-defined URL for this resource.

serviceAccounts Array.<compute(alpha).ServiceAccount>

A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

status string

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.

statusMessage string

[Output Only] An optional, human-readable explanation of the status.

tags compute(alpha).Tags

A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.

zone string

[Output Only] URL of the zone where the instance resides.

compute(alpha).InstanceAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped instance lists.

kind string

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).InstanceGroupobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] The creation timestamp for this instance group in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

fingerprint string

[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id string

[Output Only] A unique identifier for this resource type. The server generates this identifier.

kind string

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

name string

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

namedPorts Array.<compute(alpha).NamedPort>

Assigns a name to a port number. For example: {name: "http", port: 80}

This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Named ports apply to all instances in this instance group.

network string

The URL of the network to which all instances in the instance group belong.

region string

The URL of the region where the instance group is located.

selfLink string

[Output Only] The URL for this instance group. The server generates this URL.

size integer

[Output Only] The total number of instances in the instance group.

subnetwork string

The URL of the subnetwork to which all instances in the instance group belong.

zone string

[Output Only] The URL of the zone where the instance group is located.

compute(alpha).InstanceGroupAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.

items object

A map of scoped instance group lists.

kind string

[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this resource type. The server generates this URL.

compute(alpha).InstanceGroupListobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this list of instance groups. The server generates this identifier.

items Array.<compute(alpha).InstanceGroup>

A list of instance groups.

kind string

[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this resource type. The server generates this URL.

compute(alpha).InstanceGroupManagerobject

Properties:
Name Type Description
autoHealingPolicies Array.<compute(alpha).InstanceGroupManagerAutoHealingPolicy>

The autohealing policy for this managed instance group. You can specify only one value.

baseInstanceName string

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

creationTimestamp string

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

currentActions compute(alpha).InstanceGroupManagerActionsSummary

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

description string

An optional description of this resource. Provide this property when you create the resource.

failoverAction string

The action to perform in case of zone failure (set only for Regional instance group managers).

fingerprint string

[Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.

id string

[Output Only] A unique identifier for this resource type. The server generates this identifier.

instanceGroup string

[Output Only] The URL of the Instance Group resource.

instanceTemplate string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

kind string

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

name string

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

namedPorts Array.<compute(alpha).NamedPort>

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

pendingActions compute(alpha).InstanceGroupManagerPendingActionsSummary

[Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.

region string

[Output Only] URL of the region where the managed instance group resides.

selfLink string

[Output Only] The URL for this managed instance group. The server defines this URL.

targetPools Array.<string>

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

targetSize integer

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

updatePolicy compute(alpha).InstanceGroupManagerUpdatePolicy

The update policy for this managed instance group.

versions Array.<compute(alpha).InstanceGroupManagerVersion>

Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.

zone string

The name of the zone where the managed instance group is located.

compute(alpha).InstanceGroupManagerActionsSummaryobject

Properties:
Name Type Description
abandoning integer

[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.

creating integer

[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.

If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

creatingWithoutRetries integer

[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.

deleting integer

[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

none integer

[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.

recreating integer

[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.

refreshing integer

[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.

restarting integer

[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

compute(alpha).InstanceGroupManagerAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.

items object

[Output Only] A map of filtered managed instance group lists.

kind string

[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this resource type. The server generates this URL.

compute(alpha).InstanceGroupManagerAutoHealingPolicyobject

Properties:
Name Type Description
healthCheck string

The URL for the HealthCheck that signals autohealing.

initialDelaySec integer

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].

compute(alpha).InstanceGroupManagerListobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this resource type. The server generates this identifier.

items Array.<compute(alpha).InstanceGroupManager>

[Output Only] A list of managed instance groups.

kind string

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this resource type. The server generates this URL.

compute(alpha).InstanceGroupManagerPendingActionsSummaryobject

Properties:
Name Type Description
creating integer

[Output Only] The number of instances in the managed instance group that are pending to be created.

deleting integer

[Output Only] The number of instances in the managed instance group that are pending to be deleted.

recreating integer

[Output Only] The number of instances in the managed instance group that are pending to be recreated.

restarting integer

[Output Only] The number of instances in the managed instance group that are pending to be restarted.

compute(alpha).InstanceGroupManagersAbandonInstancesRequestobject

Properties:
Name Type Description
instances Array.<string>

The URL for one or more instances to abandon from the managed instance group.

compute(alpha).InstanceGroupManagersDeleteInstancesRequestobject

Properties:
Name Type Description
instances Array.<string>

The list of instances to delete from this managed instance group. Specify one or more instance URLs.

compute(alpha).InstanceGroupManagersListManagedInstancesResponseobject

Properties:
Name Type Description
managedInstances Array.<compute(alpha).ManagedInstance>

[Output Only] The list of instances in the managed instance group.

compute(alpha).InstanceGroupManagersRecreateInstancesRequestobject

Properties:
Name Type Description
instances Array.<string>

The URL for one or more instances to recreate.

compute(alpha).InstanceGroupManagersResizeAdvancedRequestobject

Properties:
Name Type Description
noCreationRetries boolean

If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.

This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.

This flag is applicable only to the current resize request. It does not influence other resize requests in any way.

You can see which instances is being creating in which mode by calling the get or listManagedInstances API.

targetSize integer

The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

compute(alpha).InstanceGroupManagersScopedListobject

Properties:
Name Type Description
instanceGroupManagers Array.<compute(alpha).InstanceGroupManager>

[Output Only] The list of managed instance groups that are contained in the specified project and zone.

warning object

[Output Only] The warning that replaces the list of managed instance groups when the list is empty.

compute(alpha).InstanceGroupManagersSetAutoHealingRequestobject

Properties:
Name Type Description
autoHealingPolicies Array.<compute(alpha).InstanceGroupManagerAutoHealingPolicy>

compute(alpha).InstanceGroupManagersSetInstanceTemplateRequestobject

Properties:
Name Type Description
instanceTemplate string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

compute(alpha).InstanceGroupManagersSetTargetPoolsRequestobject

Properties:
Name Type Description
fingerprint string

The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

targetPools Array.<string>

The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.

compute(alpha).InstanceGroupManagerUpdatePolicyobject

Properties:
Name Type Description
maxSurge compute(alpha).FixedOrPercent

Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.

maxUnavailable compute(alpha).FixedOrPercent

Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.

minReadySec integer

Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].

minimalAction string

Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.

type string

compute(alpha).InstanceGroupManagerVersionobject

Properties:
Name Type Description
instanceTemplate string
tag string

Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.

targetSize compute(alpha).FixedOrPercent

Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.

compute(alpha).InstanceGroupsAddInstancesRequestobject

Properties:
Name Type Description
instances Array.<compute(alpha).InstanceReference>

The list of instances to add to the instance group.

compute(alpha).InstanceGroupsListInstancesobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.

items Array.<compute(alpha).InstanceWithNamedPorts>

[Output Only] A list of instances and any named ports that are assigned to those instances.

kind string

[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.

compute(alpha).InstanceGroupsListInstancesRequestobject

Properties:
Name Type Description
instanceState string

A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.

compute(alpha).InstanceGroupsRemoveInstancesRequestobject

Properties:
Name Type Description
instances Array.<compute(alpha).InstanceReference>

The list of instances to remove from the instance group.

compute(alpha).InstanceGroupsScopedListobject

Properties:
Name Type Description
instanceGroups Array.<compute(alpha).InstanceGroup>

[Output Only] The list of instance groups that are contained in this scope.

warning object

[Output Only] An informational warning that replaces the list of instance groups when the list is empty.

compute(alpha).InstanceGroupsSetNamedPortsRequestobject

Properties:
Name Type Description
fingerprint string

The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

namedPorts Array.<compute(alpha).NamedPort>

The list of named ports to set for this instance group.

compute(alpha).InstanceListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Instance>

[Output Only] A list of instances.

kind string

[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).InstanceMoveRequestobject

Properties:
Name Type Description
destinationZone string

The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone
  • projects/project/zones/zone
  • zones/zone
targetInstance string

The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
  • projects/project/zones/zone/instances/instance
  • zones/zone/instances/instance

compute(alpha).InstancePropertiesobject

Properties:
Name Type Description
canIpForward boolean

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.

description string

An optional text description for the instances that are created from this instance template.

disks Array.<compute(alpha).AttachedDisk>

An array of disks that are associated with the instances that are created from this template.

labels object

Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.

machineType string

The machine type to use for instances that are created from this template.

metadata compute(alpha).Metadata

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

networkInterfaces Array.<compute(alpha).NetworkInterface>

An array of network access configurations for this interface.

scheduling compute(alpha).Scheduling

Specifies the scheduling options for the instances that are created from this template.

serviceAccounts Array.<compute(alpha).ServiceAccount>

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.

tags compute(alpha).Tags

A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

compute(alpha).InstanceReferenceobject

Properties:
Name Type Description
instance string

The URL for a specific instance.

compute(alpha).InstancesScopedListobject

Properties:
Name Type Description
instances Array.<compute(alpha).Instance>

[Output Only] List of instances contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of instances when the list is empty.

compute(alpha).InstancesSetLabelsRequestobject

Properties:
Name Type Description
labelFingerprint string

Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.

labels object

A list of labels to apply for this instance. Changing instance labels will also change the instance tags.

Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

compute(alpha).InstancesSetMachineTypeRequestobject

Properties:
Name Type Description
machineType string

Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1

compute(alpha).InstancesSetServiceAccountRequestobject

Properties:
Name Type Description
email string

Email address of the service account.

scopes Array.<string>

The list of scopes to be made available for this service account.

compute(alpha).InstancesStartWithEncryptionKeyRequestobject

Properties:
Name Type Description
disks Array.<compute(alpha).CustomerEncryptionKeyProtectedDisk>

Array of disks associated with this instance that are protected with a customer-supplied encryption key.

In order to start the instance, the disk url and its corresponding key must be provided.

If the disk is not protected with a customer-supplied encryption key it should not be specified.

instanceEncryptionKey compute(alpha).CustomerEncryptionKey

Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.

compute(alpha).InstanceTemplateobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] A unique identifier for this instance template. The server defines this identifier.

kind string

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

name string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

properties compute(alpha).InstanceProperties

The instance properties for this instance template.

selfLink string

[Output Only] The URL for this instance template. The server defines this URL.

sourceInstance string

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
  • projects/project/zones/zone/instances/instance

compute(alpha).InstanceTemplateListobject

Properties:
Name Type Description
id string

[Output Only] A unique identifier for this instance template. The server defines this identifier.

items Array.<compute(alpha).InstanceTemplate>

[Output Only] list of InstanceTemplate resources.

kind string

[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this instance template list. The server defines this URL.

compute(alpha).InstanceWithNamedPortsobject

Properties:
Name Type Description
instance string

[Output Only] The URL of the instance.

namedPorts Array.<compute(alpha).NamedPort>

[Output Only] The named ports that belong to this instance group.

status string

[Output Only] The status of the instance.

compute(alpha).Licenseobject

Properties:
Name Type Description
chargesUseFee boolean

[Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.

kind string

[Output Only] Type of resource. Always compute#license for licenses.

name string

[Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).LogConfigobject

Properties:
Name Type Description
counter compute(alpha).LogConfigCounterOptions

Counter options.

compute(alpha).LogConfigCounterOptionsobject

Properties:
Name Type Description
field string

The field value to attribute.

metric string

The metric to update.

compute(alpha).MachineTypeobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated compute(alpha).DeprecationStatus

[Output Only] The deprecation status associated with this machine type.

description string

[Output Only] An optional textual description of the resource.

guestCpus integer

[Output Only] The number of virtual CPUs that are available to the instance.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

isSharedCpu boolean

[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.

kind string

[Output Only] The type of the resource. Always compute#machineType for machine types.

maximumPersistentDisks integer

[Output Only] Maximum persistent disks allowed.

maximumPersistentDisksSizeGb string

[Output Only] Maximum total persistent disks size (GB) allowed.

memoryMb integer

[Output Only] The amount of physical memory available to the instance, defined in MB.

name string

[Output Only] Name of the resource.

selfLink string

[Output Only] Server-defined URL for the resource.

zone string

[Output Only] The name of the zone where the machine type resides, such as us-central1-a.

compute(alpha).MachineTypeAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped machine type lists.

kind string

[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).MachineTypeListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).MachineType>

[Output Only] A list of Machine Type resources.

kind string

[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).MachineTypesScopedListobject

Properties:
Name Type Description
machineTypes Array.<compute(alpha).MachineType>

[Output Only] List of machine types contained in this scope.

warning object

[Output Only] An informational warning that appears when the machine types list is empty.

compute(alpha).ManagedInstanceobject

Properties:
Name Type Description
currentAction string

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:

  • NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
  • CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
  • CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
  • RECREATING The managed instance group is recreating this instance.
  • DELETING The managed instance group is permanently deleting this instance.
  • ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
  • RESTARTING The managed instance group is restarting the instance.
  • REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
id string

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

instance string

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

instanceStatus string

[Output Only] The status of the instance. This field is empty when the instance does not exist.

instanceTemplate string

[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.

lastAttempt compute(alpha).ManagedInstanceLastAttempt

[Output Only] Information about the last attempt to create or delete the instance.

standbyMode string

[Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.

tag string

[Output Only] Tag describing the version.

compute(alpha).ManagedInstanceLastAttemptobject

Properties:
Name Type Description
errors object

[Output Only] Encountered errors during the last attempt to create or delete the instance.

compute(alpha).Metadataobject

Properties:
Name Type Description
fingerprint string

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

items Array.<object>

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

kind string

[Output Only] Type of the resource. Always compute#metadata for metadata.

compute(alpha).NamedPortobject

Properties:
Name Type Description
name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port integer

The port number, which can be a value between 1 and 65535.

compute(alpha).Networkobject

Properties:
Name Type Description
IPv4Range string

The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

autoCreateSubnetworks boolean

When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".

In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

gatewayIPv4 string

A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#network for networks.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

subnetworks Array.<string>

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.

compute(alpha).NetworkInterfaceobject

Properties:
Name Type Description
accessConfigs Array.<compute(alpha).AccessConfig>

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

name string

[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.

network string

URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:

global/networks/default

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/project/global/networks/network
  • projects/project/global/networks/network
  • global/networks/default
networkIP string

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

subnetwork string

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
  • regions/region/subnetworks/subnetwork

compute(alpha).NetworkListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Network>

[Output Only] A list of Network resources.

kind string

[Output Only] Type of resource. Always compute#networkList for lists of networks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource .

compute(alpha).Operationobject

Properties:
Name Type Description
clientOperationId string

[Output Only] Reserved for future use.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

[Output Only] A textual description of the operation, which is set when the operation is created.

endTime string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

error object

[Output Only] If errors are generated during processing of the operation, this field will be populated.

httpErrorMessage string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

httpErrorStatusCode integer

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

insertTime string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

kind string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

name string

[Output Only] Name of the resource.

operationType string

[Output Only] The type of operation, such as insert, update, or delete, and so on.

progress integer

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

region string

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations.

selfLink string

[Output Only] Server-defined URL for the resource.

startTime string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

status string

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

statusMessage string

[Output Only] An optional textual description of the current status of the operation.

targetId string

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

targetLink string

[Output Only] The URL of the resource that the operation modifies.

user string

[Output Only] User who requested the operation, for example: user@example.com.

warnings Array.<object>

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

zone string

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.

compute(alpha).OperationAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped operation lists.

kind string

[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).OperationListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Operation>

[Output Only] A list of Operation resources.

kind string

[Output Only] Type of resource. Always compute#operations for Operations resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).OperationsScopedListobject

Properties:
Name Type Description
operations Array.<compute(alpha).Operation>

[Output Only] List of operations contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of operations when the list is empty.

compute(alpha).PathMatcherobject

Properties:
Name Type Description
defaultService string

The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:

  • https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
  • compute/v1/projects/project/global/backendServices/backendService
  • global/backendServices/backendService
description string

An optional description of this resource. Provide this property when you create the resource.

name string

The name to which this PathMatcher is referred by the HostRule.

pathRules Array.<compute(alpha).PathRule>

The list of path rules.

compute(alpha).PathRuleobject

Properties:
Name Type Description
paths Array.<string>

The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

service string

The URL of the BackendService resource if this rule is matched.

compute(alpha).Policyobject

Properties:
Name Type Description
auditConfigs Array.<compute(alpha).AuditConfig>

Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.

Note: AuditConfig doesn't apply to "admin activity", which always enables audit logging.

bindings Array.<compute(alpha).Binding>

Associates a list of members to a role. Multiple bindings must not be specified for the same role. bindings with no members will result in an error.

etag string

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.

If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

iamOwned boolean
rules Array.<compute(alpha).Rule>

If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

version integer

Version of the Policy. The default version is 0.

compute(alpha).Projectobject

Properties:
Name Type Description
commonInstanceMetadata compute(alpha).Metadata

Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

defaultServiceAccount string

[Output Only] Default service account used by VMs running in this project.

description string

An optional textual description of the resource.

enabledFeatures Array.<string>

Restricted features enabled for use on this project.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

kind string

[Output Only] Type of the resource. Always compute#project for projects.

name string

The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

quotas Array.<compute(alpha).Quota>

[Output Only] Quotas assigned to this project.

selfLink string

[Output Only] Server-defined URL for the resource.

usageExportLocation compute(alpha).UsageExportLocation

The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

xpnProjectStatus string

[Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.

compute(alpha).ProjectsDisableXpnResourceRequestobject

Properties:
Name Type Description
xpnResource compute(alpha).XpnResourceId

XPN resource ID.

compute(alpha).ProjectsEnableXpnResourceRequestobject

Properties:
Name Type Description
xpnResource compute(alpha).XpnResourceId

XPN resource ID.

compute(alpha).ProjectsGetXpnResourcesobject

Properties:
Name Type Description
kind string

[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.

resources Array.<compute(alpha).XpnResourceId>

XPN resources attached to this project as their XPN host.

compute(alpha).ProjectsListXpnHostsRequestobject

Properties:
Name Type Description
organization string

Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project.

compute(alpha).Quotaobject

Properties:
Name Type Description
limit number

[Output Only] Quota limit for this metric.

metric string

[Output Only] Name of the quota metric.

usage number

[Output Only] Current usage of this metric.

compute(alpha).Regionobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated compute(alpha).DeprecationStatus

[Output Only] The deprecation status associated with this region.

description string

[Output Only] Textual description of the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#region for regions.

name string

[Output Only] Name of the resource.

quotas Array.<compute(alpha).Quota>

[Output Only] Quotas assigned to this region.

selfLink string

[Output Only] Server-defined URL for the resource.

status string

[Output Only] Status of the region, either UP or DOWN.

zones Array.<string>

[Output Only] A list of zones available in this region, in the form of resource URLs.

compute(alpha).RegionAutoscalerListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Autoscaler>

A list of autoscalers.

kind string

Type of resource.

nextPageToken string

[Output Only] A token used to continue a truncated list request.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).RegionDiskListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Disk>

[Output Only] A list of persistent disks.

kind string

[Output Only] Type of resource. Always compute#regionDiskList for lists of region disks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).RegionDisksResizeRequestobject

Properties:
Name Type Description
sizeGb string

The new size of the regional persistent disk, which is specified in GB.

compute(alpha).RegionDiskTypeListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).DiskType>

[Output Only] A list of Disk Type resources.

kind string

[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).RegionInstanceGroupListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).InstanceGroup>

A list of InstanceGroup resources.

kind string

The resource type.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] The URL for this resource type. The server generates this URL.

compute(alpha).RegionInstanceGroupManagerListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).InstanceGroupManager>

A list of managed instance groups.

kind string

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.

nextPageToken string

[Output only] A token used to continue a truncated list request.

selfLink string

[Output only] The URL for this resource type. The server generates this URL.

compute(alpha).RegionInstanceGroupManagersAbandonInstancesRequestobject

Properties:
Name Type Description
instances Array.<string>

The names of one or more instances to abandon.

compute(alpha).RegionInstanceGroupManagersDeleteInstancesRequestobject

Properties:
Name Type Description
instances Array.<string>

The names of one or more instances to delete.

compute(alpha).RegionInstanceGroupManagersListInstancesResponseobject

Properties:
Name Type Description
managedInstances Array.<compute(alpha).ManagedInstance>

List of managed instances.

compute(alpha).RegionInstanceGroupManagersRecreateRequestobject

Properties:
Name Type Description
instances Array.<string>

The URL for one or more instances to recreate.

compute(alpha).RegionInstanceGroupManagersSetAutoHealingRequestobject

Properties:
Name Type Description
autoHealingPolicies Array.<compute(alpha).InstanceGroupManagerAutoHealingPolicy>

compute(alpha).RegionInstanceGroupManagersSetTargetPoolsRequestobject

Properties:
Name Type Description
fingerprint string

Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.

targetPools Array.<string>

The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

compute(alpha).RegionInstanceGroupManagersSetTemplateRequestobject

Properties:
Name Type Description
instanceTemplate string

URL of the InstanceTemplate resource from which all new instances will be created.

compute(alpha).RegionInstanceGroupsListInstancesobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items Array.<compute(alpha).InstanceWithNamedPorts>

A list of instances and any named ports that are assigned to those instances.

kind string

The resource type.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).RegionInstanceGroupsListInstancesRequestobject

Properties:
Name Type Description
instanceState string

Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.

portName string

Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.

compute(alpha).RegionInstanceGroupsSetNamedPortsRequestobject

Properties:
Name Type Description
fingerprint string

The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.

namedPorts Array.<compute(alpha).NamedPort>

The list of named ports to set for this instance group.

compute(alpha).RegionListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Region>

[Output Only] A list of Region resources.

kind string

[Output Only] Type of resource. Always compute#regionList for lists of regions.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).RegionSetLabelsRequestobject

Properties:
Name Type Description
labelFingerprint string

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

labels object

The labels to set for this resource.

compute(alpha).ResourceGroupReferenceobject

Properties:
Name Type Description
group string

A URI referencing one of the resource views listed in the backend service.

compute(alpha).Routeobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

destRange string

The destination range of outgoing packets that this route applies to.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of this resource. Always compute#routes for Route resources.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

Fully-qualified URL of the network that this route applies to.

nextHopGateway string

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway

nextHopInstance string

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

nextHopIp string

The network IP address of an instance that should handle matching packets.

nextHopNetwork string

The URL of the local network if it should handle matching packets.

nextHopVpnTunnel string

The URL to a VpnTunnel that should handle matching packets.

priority integer

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

selfLink string

[Output Only] Server-defined fully-qualified URL for this resource.

tags Array.<string>

A list of instance tags to which this route applies.

warnings Array.<object>

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

compute(alpha).RouteListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items Array.<compute(alpha).Route>

[Output Only] A list of Route resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).Routerobject

Properties:
Name Type Description
bgp compute(alpha).RouterBgp

BGP information specific to this router.

bgpPeers Array.<compute(alpha).RouterBgpPeer>

BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

interfaces Array.<compute(alpha).RouterInterface>

Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).

kind string

[Output Only] Type of resource. Always compute#router for routers.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

URI of the network to which this router belongs.

region string

[Output Only] URI of the region where the router resides.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).RouterAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

A map of scoped router lists.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).RouterBgpobject

Properties:
Name Type Description
asn integer

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

compute(alpha).RouterBgpPeerobject

Properties:
Name Type Description
advertisedRoutePriority integer

The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.

interfaceName string

Name of the interface the BGP peer is associated with.

ipAddress string

IP address of the interface inside Google Cloud Platform.

name string

Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.

peerAsn integer

Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.

peerIpAddress string

IP address of the BGP interface outside Google cloud.

compute(alpha).RouterInterfaceobject

Properties:
Name Type Description
ipRange string

IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

linkedVpnTunnel string

URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.

name string

Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.

compute(alpha).RouterListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Router>

A list of Router resources.

kind string

[Output Only] Type of resource. Always compute#router for routers.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).RoutersPreviewResponseobject

Properties:
Name Type Description
resource compute(alpha).Router

Preview of given router.

compute(alpha).RoutersScopedListobject

Properties:
Name Type Description
routers Array.<compute(alpha).Router>

List of routers contained in this scope.

warning object

Informational warning which replaces the list of routers when the list is empty.

compute(alpha).RouterStatusobject

Properties:
Name Type Description
bestRoutes Array.<compute(alpha).Route>

Best routes for this router's network.

bgpPeerStatus Array.<compute(alpha).RouterStatusBgpPeerStatus>
network string

URI of the network to which this router belongs.

compute(alpha).RouterStatusBgpPeerStatusobject

Properties:
Name Type Description
advertisedRoutes Array.<compute(alpha).Route>

Routes that were advertised to the remote BGP peer

ipAddress string

IP address of the local BGP interface.

linkedVpnTunnel string

URL of the VPN tunnel that this BGP peer controls.

name string

Name of this BGP peer. Unique within the Routers resource.

numLearnedRoutes integer

Number of routes learned from the remote BGP Peer.

peerIpAddress string

IP address of the remote BGP interface.

state string

BGP state as specified in RFC1771.

status string

Status of the BGP peer: {UP, DOWN}

uptime string

Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

uptimeSeconds string

Time this session has been up, in seconds. Format: 145

compute(alpha).RouterStatusResponseobject

Properties:
Name Type Description
kind string

Type of resource.

result compute(alpha).RouterStatus

compute(alpha).Ruleobject

Properties:
Name Type Description
action string

Required

conditions Array.<compute(alpha).Condition>

Additional restrictions that must be met

description string

Human-readable description of the rule.

ins Array.<string>

If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

logConfigs Array.<compute(alpha).LogConfig>

The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

notIns Array.<string>

If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

permissions Array.<string>

A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '' matches all permissions, and a verb part of '' (e.g., 'storage.buckets.*') matches all verbs.

compute(alpha).Schedulingobject

Properties:
Name Type Description
automaticRestart boolean

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

onHostMaintenance string

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

preemptible boolean

Whether the instance is preemptible.

compute(alpha).SerialPortOutputobject

Properties:
Name Type Description
contents string

[Output Only] The contents of the console output.

kind string

[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

next string

[Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.

selfLink string

[Output Only] Server-defined URL for the resource.

start string

[Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.

compute(alpha).ServiceAccountobject

Properties:
Name Type Description
email string

Email address of the service account.

scopes Array.<string>

The list of scopes to be made available for this service account.

compute(alpha).Snapshotobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

diskSizeGb string

[Output Only] Size of the snapshot, specified in GB.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

labelFingerprint string

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve a snapshot.

labels object

Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

licenses Array.<string>

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

name string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

snapshotEncryptionKey compute(alpha).CustomerEncryptionKey

Encrypts the snapshot using a customer-supplied encryption key.

After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

sourceDisk string

[Output Only] The source disk used to create this snapshot.

sourceDiskEncryptionKey compute(alpha).CustomerEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

sourceDiskId string

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

status string

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

storageBytes string

[Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

storageBytesStatus string

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

compute(alpha).SnapshotListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Snapshot>

[Output Only] A list of Snapshot resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).SslCertificateobject

Properties:
Name Type Description
certificate string

A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

privateKey string

A write-only private key in PEM format. Only insert RPCs will include this field.

selfLink string

[Output only] Server-defined URL for the resource.

compute(alpha).SslCertificateListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items Array.<compute(alpha).SslCertificate>

A list of SslCertificate resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).SSLHealthCheckobject

Properties:
Name Type Description
port integer

The TCP port number for the health check request. The default value is 443.

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

request string

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

response string

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

compute(alpha).Subnetworkobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

gatewayAddress string

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

ipCidrRange string

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.

kind string

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

name string

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.

privateIpGoogleAccess boolean

Whether the VMs in this subnet can access Google services without assigned external IP addresses.

region string

URL of the region where the Subnetwork resides.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).SubnetworkAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output] A map of scoped Subnetwork lists.

kind string

[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).SubnetworkListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Subnetwork>

The Subnetwork resources.

kind string

[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).SubnetworksExpandIpCidrRangeRequestobject

Properties:
Name Type Description
ipCidrRange string

The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.

compute(alpha).SubnetworksScopedListobject

Properties:
Name Type Description
subnetworks Array.<compute(alpha).Subnetwork>

List of subnetworks contained in this scope.

warning object

An informational warning that appears when the list of addresses is empty.

compute(alpha).Tagsobject

Properties:
Name Type Description
fingerprint string

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

To see the latest fingerprint, make get() request to the instance.

items Array.<string>

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

compute(alpha).TargetHttpProxyobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

urlMap string

URL to the UrlMap resource that defines the mapping from URL to the BackendService.

compute(alpha).TargetHttpProxyListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).TargetHttpProxy>

A list of TargetHttpProxy resources.

kind string

Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetHttpsProxiesSetSslCertificatesRequestobject

Properties:
Name Type Description
sslCertificates Array.<string>

New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.

compute(alpha).TargetHttpsProxyobject

Properties:
Name Type Description
clientSslPolicy string

URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

selfLink string

[Output Only] Server-defined URL for the resource.

sslCertificates Array.<string>

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.

urlMap string

A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:

  • https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
  • projects/project/global/urlMaps/url-map
  • global/urlMaps/url-map

compute(alpha).TargetHttpsProxyListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).TargetHttpsProxy>

A list of TargetHttpsProxy resources.

kind string

Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetInstanceobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instance string

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
  • projects/project/zones/zone/instances/instance
  • zones/zone/instances/instance
kind string

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

natPolicy string

NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.

selfLink string

[Output Only] Server-defined URL for the resource.

zone string

[Output Only] URL of the zone where the target instance resides.

compute(alpha).TargetInstanceAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items object

A map of scoped target instance lists.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetInstanceListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).TargetInstance>

A list of TargetInstance resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetInstancesScopedListobject

Properties:
Name Type Description
targetInstances Array.<compute(alpha).TargetInstance>

List of target instances contained in this scope.

warning object

Informational warning which replaces the list of addresses when the list is empty.

compute(alpha).TargetPoolobject

Properties:
Name Type Description
backupPool string

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

failoverRatio number

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

healthChecks Array.<string>

A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instances Array.<string>

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

kind string

[Output Only] Type of the resource. Always compute#targetPool for target pools.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region string

[Output Only] URL of the region where the target pool resides.

selfLink string

[Output Only] Server-defined URL for the resource.

sessionAffinity string

Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

compute(alpha).TargetPoolAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items object

[Output Only] A map of scoped target pool lists.

kind string

[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetPoolInstanceHealthobject

Properties:
Name Type Description
healthStatus Array.<compute(alpha).HealthStatus>
kind string

[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.

compute(alpha).TargetPoolListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Defined by the server.

items Array.<compute(alpha).TargetPool>

A list of TargetPool resources.

kind string

[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetPoolsAddHealthCheckRequestobject

Properties:
Name Type Description
healthChecks Array.<compute(alpha).HealthCheckReference>

A list of HttpHealthCheck resources to add to the target pool.

compute(alpha).TargetPoolsAddInstanceRequestobject

Properties:
Name Type Description
instances Array.<compute(alpha).InstanceReference>

A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:

  • https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
  • projects/project-id/zones/zone/instances/instance-name
  • zones/zone/instances/instance-name

compute(alpha).TargetPoolsRemoveHealthCheckRequestobject

Properties:
Name Type Description
healthChecks Array.<compute(alpha).HealthCheckReference>

Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:

  • https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
  • projects/project/global/httpHealthChecks/health-check
  • global/httpHealthChecks/health-check

compute(alpha).TargetPoolsRemoveInstanceRequestobject

Properties:
Name Type Description
instances Array.<compute(alpha).InstanceReference>

URLs of the instances to be removed from target pool.

compute(alpha).TargetPoolsScopedListobject

Properties:
Name Type Description
targetPools Array.<compute(alpha).TargetPool>

List of target pools contained in this scope.

warning object

Informational warning which replaces the list of addresses when the list is empty.

compute(alpha).TargetReferenceobject

Properties:
Name Type Description
target string

compute(alpha).TargetSslProxiesSetBackendServiceRequestobject

Properties:
Name Type Description
service string

The URL of the new BackendService resource for the targetSslProxy.

compute(alpha).TargetSslProxiesSetProxyHeaderRequestobject

Properties:
Name Type Description
proxyHeader string

The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

compute(alpha).TargetSslProxiesSetSslCertificatesRequestobject

Properties:
Name Type Description
sslCertificates Array.<string>

New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.

compute(alpha).TargetSslProxyobject

Properties:
Name Type Description
clientSslPolicy string

URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.

creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

selfLink string

[Output Only] Server-defined URL for the resource.

service string

URL to the BackendService resource.

sslCertificates Array.<string>

URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.

compute(alpha).TargetSslProxyListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).TargetSslProxy>

A list of TargetSslProxy resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).TargetVpnGatewayobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

forwardingRules Array.<string>

[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network string

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

region string

[Output Only] URL of the region where the target VPN gateway resides.

selfLink string

[Output Only] Server-defined URL for the resource.

status string

[Output Only] The status of the VPN gateway.

tunnels Array.<string>

[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.

compute(alpha).TargetVpnGatewayAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

A map of scoped target vpn gateway lists.

kind string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).TargetVpnGatewayListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).TargetVpnGateway>

[Output Only] A list of TargetVpnGateway resources.

kind string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).TargetVpnGatewaysScopedListobject

Properties:
Name Type Description
targetVpnGateways Array.<compute(alpha).TargetVpnGateway>

[Output Only] List of target vpn gateways contained in this scope.

warning object

[Output Only] Informational warning which replaces the list of addresses when the list is empty.

compute(alpha).TCPHealthCheckobject

Properties:
Name Type Description
port integer

The TCP port number for the health check request. The default value is 80.

portName string

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

proxyHeader string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

request string

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

response string

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

compute(alpha).TestFailureobject

Properties:
Name Type Description
actualService string
expectedService string
host string
path string

compute(alpha).TestPermissionsRequestobject

Properties:
Name Type Description
permissions Array.<string>

The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.

compute(alpha).TestPermissionsResponseobject

Properties:
Name Type Description
permissions Array.<string>

A subset of TestPermissionsRequest.permissions that the caller is allowed.

compute(alpha).UrlMapobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

defaultService string

The URL of the BackendService resource if none of the hostRules match.

description string

An optional description of this resource. Provide this property when you create the resource.

fingerprint string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.

hostRules Array.<compute(alpha).HostRule>

The list of HostRules to use against the URL.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

pathMatchers Array.<compute(alpha).PathMatcher>

The list of named PathMatchers to use against the URL.

selfLink string

[Output Only] Server-defined URL for the resource.

tests Array.<compute(alpha).UrlMapTest>

The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.

compute(alpha).UrlMapListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource. Set by the server.

items Array.<compute(alpha).UrlMap>

A list of UrlMap resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).UrlMapReferenceobject

Properties:
Name Type Description
urlMap string

compute(alpha).UrlMapsValidateRequestobject

Properties:
Name Type Description
resource compute(alpha).UrlMap

Content of the UrlMap to be validated.

compute(alpha).UrlMapsValidateResponseobject

Properties:
Name Type Description
result compute(alpha).UrlMapValidationResult

compute(alpha).UrlMapTestobject

Properties:
Name Type Description
description string

Description of this test case.

host string

Host portion of the URL.

path string

Path portion of the URL.

service string

Expected BackendService resource the given URL should be mapped to.

compute(alpha).UrlMapValidationResultobject

Properties:
Name Type Description
loadErrors Array.<string>
loadSucceeded boolean

Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.

testFailures Array.<compute(alpha).TestFailure>
testPassed boolean

If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

compute(alpha).UsageExportLocationobject

Properties:
Name Type Description
bucketName string

The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

reportNamePrefix string

An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

compute(alpha).VpnTunnelobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

detailedStatus string

[Output Only] Detailed status message for the VPN tunnel.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

ikeVersion integer

IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.

kind string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

localTrafficSelector Array.<string>

Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.

name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

peerIp string

IP address of the peer VPN gateway.

region string

[Output Only] URL of the region where the VPN tunnel resides.

remoteTrafficSelector Array.<string>

Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.

router string

URL of router resource to be used for dynamic routing.

selfLink string

[Output Only] Server-defined URL for the resource.

sharedSecret string

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

sharedSecretHash string

Hash of the shared secret.

status string

[Output Only] The status of the VPN tunnel.

targetVpnGateway string

URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

compute(alpha).VpnTunnelAggregatedListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items object

[Output Only] A map of scoped vpn tunnel lists.

kind string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).VpnTunnelListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).VpnTunnel>

[Output Only] A list of VpnTunnel resources.

kind string

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for the resource.

compute(alpha).VpnTunnelsScopedListobject

Properties:
Name Type Description
vpnTunnels Array.<compute(alpha).VpnTunnel>

List of vpn tunnels contained in this scope.

warning object

Informational warning which replaces the list of addresses when the list is empty.

compute(alpha).XpnHostListobject

Properties:
Name Type Description
id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

items Array.<compute(alpha).Project>

[Output Only] A list of XPN host project URLs.

kind string

[Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource .

compute(alpha).XpnResourceIdobject

Properties:
Name Type Description
id string

The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.

type string

The type of the XPN resource.

compute(alpha).Zoneobject

Properties:
Name Type Description
creationTimestamp string

[Output Only] Creation timestamp in RFC3339 text format.

deprecated compute(alpha).DeprecationStatus

[Output Only] The deprecation status associated with this zone.

description string

[Output Only] Textual description of the resource.

id string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind string

[Output Only] Type of the resource. Always compute#zone for zones.

name string

[Output Only] Name of the resource.

region string

[Output Only] Full URL reference to the region which hosts the zone.

selfLink string

[Output Only] Server-defined URL for the resource.

status string

[Output Only] Status of the zone, either UP or DOWN.

compute(alpha).ZoneListobject

Properties:
Name Type Description
id string

[Output Only] Unique identifier for the resource; defined by the server.

items Array.<compute(alpha).Zone>

[Output Only] A list of Zone resources.

kind string

Type of resource.

nextPageToken string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

selfLink string

[Output Only] Server-defined URL for this resource.

compute(alpha).ZoneSetLabelsRequestobject

Properties:
Name Type Description
labelFingerprint string

The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

labels object

The labels to set for this resource.